/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef _QmitkServiceListWidget_H_INCLUDED
#define _QmitkServiceListWidget_H_INCLUDED

#include "MitkQtWidgetsExports.h"
#include "ui_QmitkServiceListWidgetControls.h"
#include <vector>

// QT headers
#include <QListWidgetItem>
#include <QWidget>

// Microservices
#include "mitkServiceInterface.h"
#include "usModuleContext.h"
#include "usServiceEvent.h"
#include "usServiceReference.h"

/**
 * \ingroup QmitkModule
 *
 * \brief This widget provides abstraction for the handling of MicroServices.
 *
 * Place one in your Plugin and set it to look for a certain interface.
 * One can also specify a filter and / or a property to use for captioning of
 * the services. It also offers functionality to signal
 * ServiceEvents and to return the actual classes, so only a minimum of
 * interaction with the MicroserviceInterface is required.
 * To get started, just put it in your Plugin or Widget, call the Initialize
 * Method and optionally connect it's signals.
 * As QT limits templating possibilities, events only throw ServiceReferences.
 * You can manually dereference them using TranslateServiceReference()
*/
class MITKQTWIDGETS_EXPORT QmitkServiceListWidget : public QWidget
{
  // this is needed for all Qt objects that should have a MOC object (everything that derives from QObject)
  Q_OBJECT

private:
  us::ModuleContext *m_Context;
  /** \brief a filter to further narrow down the list of results*/
  std::string m_Filter;
  /** \brief The name of the ServiceInterface that this class should list */
  std::string m_Interface;
  /** \brief The name of the ServiceProperty that will be displayed in the list to represent the service */
  std::string m_NamingProperty;
  /** \brief Determines if the first entry of the list should be selected automatically if no entry was selected before
   * (default false). */
  bool m_AutomaticallySelectFirstEntry;

public:
  static const std::string VIEW_ID;

  QmitkServiceListWidget(QWidget *p = nullptr, Qt::WindowFlags f1 = nullptr);
  ~QmitkServiceListWidget() override;

  /** \brief Set if the first entry of the list should be selected automatically if no entry was selected before. */
  void SetAutomaticallySelectFirstEntry(bool automaticallySelectFirstEntry);

  /** \brief This method is part of the widget an needs not to be called separately. */
  virtual void CreateQtPartControl(QWidget *parent);
  /** \brief This method is part of the widget an needs not to be called separately. (Creation of the connections of
   * main and control widget.)*/
  virtual void CreateConnections();

  /**
  * \brief Will return true, if a service is currently selected and false otherwise.
  *
  * Call this before requesting service references to avoid invalid ServiceReferences.
  */
  bool GetIsServiceSelected();

  /**
  * \brief Returns the currently selected Service as a ServiceReference.
  *
  * If no Service is selected, the result will probably be a bad pointer. call GetIsServiceSelected()
  * beforehand to avoid this
  */
  us::ServiceReferenceU GetSelectedServiceReference();

  /**
   * @return Returns all service references that are displayed in this widget.
   */
  std::vector<us::ServiceReferenceU> GetAllServiceReferences();

  /**
  * \brief Use this function to return the all listed services as a class directly.
  *
  *  Make sure you pass the appropriate type, or else this call will fail.
  *  Usually, you will pass the class itself, not the SmartPointer, but the function returns a pointer.
  */
  template <class T>
  std::vector<T *> GetAllServices()
  {
    // if (this->m_Controls->m_ServiceList->currentRow()==-1) return nullptr;
    std::vector<us::ServiceReferenceU> refs = GetAllServiceReferences();
    std::vector<T *> result;
    for (std::size_t i = 0; i < refs.size(); i++)
    {
      result.push_back(m_Context->GetService(us::ServiceReference<T>(refs[i])));
    }
    return result;
  }

  /**
  * \brief Use this function to return the currently selected service as a class directly.
  *
  *  Make sure you pass the appropriate type, or else this call will fail.
  *  Usually, you will pass the class itself, not the SmartPointer, but the function returns a pointer. Example:
  *  \verbatim mitk::USDevice::Pointer device = GetSelectedService<mitk::USDevice>(); \endverbatim
  *  @return Returns the current selected device. Returns nullptr if no device is selected.
  */
  template <class T>
  T *GetSelectedService()
  {
    if (this->m_Controls->m_ServiceList->currentRow() == -1)
      return nullptr;
    us::ServiceReferenceU ref = GetServiceForListItem(this->m_Controls->m_ServiceList->currentItem());
    return (m_Context->GetService(us::ServiceReference<T>(ref)));
  }

  /**
  * \brief  Initializes the Widget with essential parameters.
  *
  * The string filter is an LDAP parsable String, compare mitk::ModuleContext for examples on filtering.
  * Pass class T to tell the widget which class it should filter for - only services of this class will be listed.
  * NamingProperty is a property that will be used to caption the Items in the list. If no filter is supplied, all
  * matching interfaces are shown. If no namingProperty is supplied, the interfaceName will be used to caption Items in
  the list.
  * For example, this Initialization will filter for all USDevices that are set to active. The USDevice's model will be
  used to display it in the list:
  * \verbatim
      std::string filter = "(&(" + us::ServiceConstants::OBJECTCLASS() + "=" +
  "org.mitk.services.UltrasoundDevice)(IsActive=true))";
      m_Controls.m_ActiveVideoDevices->Initialize<mitk::USDevice>(mitk::USDevice::GetPropertyKeys().US_PROPKEY_NAME
  ,filter);
  * \endverbatim
  */
  template <class T>
  void Initialize(const std::string &namingProperty = static_cast<std::string>(""),
                  const std::string &filter = static_cast<std::string>(""))
  {
    std::string interfaceName(us_service_interface_iid<T>());
    m_Interface = interfaceName;
    InitPrivate(namingProperty, filter);
  }

  /**
  * \brief Translates a serviceReference to a class of the given type.
  *
  * Use this to translate the signal's parameters. To adhere to the MicroService contract,
  * only ServiceReferences stemming from the same widget should be used as parameters for this method.
  * \verbatim mitk::USDevice::Pointer device = TranslateReference<mitk::USDevice>(myDeviceReference); \endverbatim
  */
  template <class T>
  T *TranslateReference(const us::ServiceReferenceU &reference)
  {
    return m_Context->GetService(us::ServiceReference<T>(reference));
  }

  /**
  *\brief This Function listens to ServiceRegistry changes and updates the list of services accordingly.
  *
  * The user of this widget does not need to call this method, it is instead used to recieve events from the module
  *registry.
  */
  void OnServiceEvent(const us::ServiceEvent event);

signals:

  /**
  *\brief Emitted when a new Service matching the filter is being registered.
  *
  * Be careful if you use a filter:
  * If a device does not match the filter when registering, but modifies it's properties later to match the filter,
  * then the first signal you will see this device in will be ServiceModified.
  */
  void ServiceRegistered(us::ServiceReferenceU);

  /**
  *\brief Emitted directly before a Service matching the filter is being unregistered.
  */
  void ServiceUnregistering(us::ServiceReferenceU);

  /**
  *\brief Emitted when a Service matching the filter changes it's properties, or when a service that formerly not
  *matched the filter
  * changed it's properties and now matches the filter.
  */
  void ServiceModified(us::ServiceReferenceU);

  /**
  *\brief Emitted when a Service matching the filter changes it's properties,
  *
  * and the new properties make it fall trough the filter. This effectively means that
  * the widget will not track the service anymore. Usually, the Service should still be useable though
  */
  void ServiceModifiedEndMatch(us::ServiceReferenceU);

  /**
  *\brief Emitted if the user selects a Service from the list.
  *
  * If no service is selected, an invalid serviceReference is returned. The user can easily check for this.
  * if (serviceReference) will evaluate to false, if the reference is invalid and true if valid.
  */
  void ServiceSelectionChanged(us::ServiceReferenceU);

public slots:

protected slots:

  /**
  \brief Called, when the selection in the list of Services changes.
  */
  void OnServiceSelectionChanged();

protected:
  Ui::QmitkServiceListWidgetControls *m_Controls; ///< member holding the UI elements of this widget

  /**
  * \brief  Internal structure used to link ServiceReferences to their QListWidgetItems
  */
  struct ServiceListLink
  {
    us::ServiceReferenceU service;
    QListWidgetItem *item;
  };

  /**
  * \brief Finishes initialization after Initialize has been called.
  *
  * This function assumes that m_Interface is set correctly (Which Initialize does).
  */
  void InitPrivate(const std::string &namingProperty, const std::string &filter);

  /**
  * \brief Contains a list of currently active services and their entires in the list. This is wiped with every
  * ServiceRegistryEvent.
  */
  std::vector<ServiceListLink> m_ListContent;

  /**
  * \brief Constructs a ListItem from the given service, displays it, and locally stores the service.
  */
  QListWidgetItem *AddServiceToList(const us::ServiceReferenceU &serviceRef);

  /**
  * \brief Removes the given service from the list and cleans up. Returns true if successful, false if service was not
  * found.
  */
  bool RemoveServiceFromList(const us::ServiceReferenceU &serviceRef);

  /**
   * \brief Changes list entry of given service to match the changed service properties.
   * \return true if successful, false if service was not found
   */
  bool ChangeServiceOnList(const us::ServiceReferenceU &serviceRef);

  /**
  * \brief Returns the serviceReference corresponding to the given ListEntry or an invalid one if none was found (will
  * evaluate to false in bool expressions).
  */
  us::ServiceReferenceU GetServiceForListItem(QListWidgetItem *item);

  /**
  * \brief Returns a list of ServiceReferences matching the filter criteria by querying the service registry.
  */
  std::vector<us::ServiceReferenceU> GetAllRegisteredServices();

  /**
   * \brief Gets string from the naming property of the service.
   * \return caption string for given us::ServiceReferenceU
   */
  QString CreateCaptionForService(const us::ServiceReferenceU &serviceRef);
};

#endif // _QmitkServiceListWidget_H_INCLUDED
